home *** CD-ROM | disk | FTP | other *** search
/ Computer Select (Limited Edition) / Computer Select.iso / pcc / v05n06 / helpbat.doc < prev    next >
Text File  |  1992-05-11  |  2KB  |  37 lines
  1. HELPBAT.DOC                   June 1992         Ronny Richardson
  2. ----------------------------------------------------------------
  3. Purpose:  HELPBAT2.BAT, CHK2.BAT, and HELPBAT.BAT are three
  4.           batch files designed to add a simple help system to
  5.           your existing batch files.
  6.  
  7. Comments: By adding a few lines to your existing batch files,
  8.           you can create a simple help system that makes it
  9.           easy to find the right file for the job.
  10.  
  11. Usage:    HELPBAT.BAT gives you a list of each batch file and 
  12.           its purpose (those that have been edited like 
  13.           HELPBAT2.BAT in the example).
  14.  
  15.           Start every batch file you use with these three lines
  16.           of information:
  17.  
  18.           @ECHO OFF           <use ECHO OFF for DOS prior to 3.3>
  19.           REM NAME: CHECK.BAT          <substitute your filename>
  20.           REM PURPOSE: Run CHKDSK            <substitute purpose>
  21.  
  22.           Use capital letters for NAME and PURPOSE to ensure that
  23.           DOS case-sensitive searches will find the lines. It
  24.           doesn't hurt to add VERSION and DATE lines like these
  25.           to provide an audit trail for tracking modifications:
  26.  
  27.           REM VERSION:   1.00         <substitute version number>
  28.           REM DATE: May 20, 1991           <substitute date here>
  29.  
  30.           After you have modified your files, HELPBAT.BAT
  31.           rummages through each batch file on your disk and 
  32.           displays its name and purpose.  In this example, it
  33.           is assumed that you keep all your batch files in a
  34.           common directory such as C:\BATCH.
  35.  
  36.  
  37.